home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #4 / Amiga Plus CD - 2000 - No. 4.iso / Tools / Dev / Bgui / AutoDoc / windowclass.doc < prev   
Encoding:
Text File  |  2000-05-09  |  4.3 KB  |  229 lines
  1. TABLE OF CONTENTS
  2.  
  3. windowclass/--background--
  4. windowclass/WM_CLOSE
  5. windowclass/WM_GADGETKEY
  6. windowclass/WM_HANDLEIDCMP
  7. windowclass/WM_KEY[xxx]
  8. windowclass/WM_OPEN
  9. windowclass/WM_SLEEP
  10. windowclass/WM_WAKEUP
  11.  
  12. windowclass/--background--
  13.  
  14. NAME
  15.  
  16.    Class:      windowclass
  17.    Superclass: ROOTCLASS
  18.    Include File: <libraries/bgui.h>
  19.  
  20. FUNCTION
  21.  
  22.    To provide an easy to use BGUI interface to intuition windows. The
  23.    window class provides just about everything you need to create windows
  24.    with a fully font-sensitive and size-adjustable GUI.
  25.  
  26.    Objects of this class send out the following attributes:
  27.  
  28.    WINDOW_IsOpen - TRUE is window open, FALSE is closed.
  29.  
  30. windowclass/WM_CLOSE
  31.  
  32. NAME
  33.  
  34.   WM_CLOSE -- Close the window.
  35.  
  36. SYNOPSIS
  37.  
  38.   succ = DoMethod( obj, WM_CLOSE )
  39.  
  40.   ULONG succ;
  41.  
  42. FUNCTION
  43.  
  44.   This method will close the window. It is safe to call this method even
  45.   when the window is not open.
  46.  
  47. INPUTS
  48.  
  49. RESULT
  50.  
  51.   succ - TRUE upon success and FALSE upon failure.
  52.  
  53. SEE ALSO
  54.  
  55.   WM_OPEN
  56.  
  57. windowclass/WM_GADGETKEY
  58.  
  59. NAME
  60.  
  61.   WM_GADGETKEY -- Add a gadget hotkey.
  62.  
  63. SYNOPSIS
  64.  
  65.   succ = DoMethod( obj, WM_GADGETKEY, req, target, key )
  66.  
  67.   ULONG succ;
  68.   struct Requester *req;
  69.   Object *target;
  70.   STRPTR key;
  71.  
  72. FUNCTION
  73.  
  74.   With this method you can assign a key to trigger a gadget object in
  75.   the window. The object which is connected to the key will then be
  76.   controllable by the specified key.
  77.  
  78. INPUTS
  79.  
  80.   req - This version of the library does not support BGUI gadget
  81.     objects in requesters so this field must be set to NULL.
  82.  
  83.   target - This must be a pointer to the object which the key will
  84.     control.
  85.  
  86.   key - This must point to a string in which a single character
  87.     is located. The character is the key which controls the object
  88.     when it is pressed.
  89.  
  90. RESULT
  91.  
  92.   succ - TRUE upon success and FALSE upon failure.
  93.  
  94. windowclass/WM_HANDLEIDCMP
  95.  
  96. NAME
  97.  
  98.   WM_HANDLEIDCMP -- Handle window events.
  99.  
  100. SYNOPSIS
  101.  
  102.   id = DoMethod( obj, WM_HANDLEIDCMP )
  103.  
  104.   ULONG id;
  105.  
  106. FUNCTION
  107.  
  108.   This method must be used to call the windowclass event handler. The
  109.   event handler will act upon the messages present at the window's
  110.   message port and return you ID's on which to act.
  111.  
  112. INPUTS
  113.  
  114. RESULT
  115.  
  116.   id  - This can be any of the following:
  117.  
  118.     WMHI_CLOSEWINDOW -- The window's close gadget was selected.
  119.     WMHI_NOMORE -- No more messages waiting.
  120.     WMHI_INACTIVE -- The window was de-activated.
  121.     WMHI_ACTIVE -- The window was activated.
  122.     WMHI_IGNORE -- Ignore this result.
  123.  
  124.     Any return code which differs from the ones above is the ID
  125.     of a selected object (gadget or menu).
  126.  
  127.     Please look at the demo programs for more information.
  128.  
  129. windowclass/WM_KEY[xxx]
  130.  
  131. NAME
  132.  
  133.   WM_KEYACTIVE, WM_KEYINPUT, WM_KEY_INACTIVE -- See "methods.doc"
  134.  
  135. FUNCTION
  136.  
  137.   These three methods are sent to the gadget object during a key-session.
  138.   Please refer to the "methods.doc" file for more information.
  139.  
  140. windowclass/WM_OPEN
  141.  
  142. NAME
  143.  
  144.   WM_OPEN -- Open the window.
  145.  
  146. SYNOPSIS
  147.  
  148.   win = DoMethod( obj, WM_OPEN )
  149.  
  150.   struct Window *win;
  151.  
  152. FUNCTION
  153.  
  154.   This method will open up the window. If successful a pointer to the
  155.   window structure is returned. It is safe to call this method when the
  156.   window is already open.
  157.  
  158. INPUTS
  159.  
  160. RESULT
  161.  
  162.   win - A pointer to the opened window upon success and NULL upon failure.
  163.  
  164. SEE ALSO
  165.  
  166.   WM_CLOSE
  167.  
  168. windowclass/WM_SLEEP
  169.  
  170. NAME
  171.  
  172.   WM_SLEEP -- Put the window to sleep.
  173.  
  174. SYNOPSIS
  175.  
  176.   succ = DoMethod( obj, WM_SLEEP )
  177.  
  178.   ULONG succ;
  179.  
  180. FUNCTION
  181.  
  182.   With this method you can put your window to sleep when it is open.
  183.   This is done by setting up a small invisible requester which will
  184.   block the window input possibilities. Also a standard Workbench busy
  185.   pointer is set in the window.
  186.  
  187.   This call is nested. This means the window has to be released with
  188.   WM_WAKEUP as much times as you have locked it with WM_SLEEP.
  189.  
  190. INPUTS
  191.  
  192. RESULT
  193.  
  194.   succ  - TRUE upon success and FALSE upon failure.
  195.  
  196. SEE ALSO
  197.  
  198.   WM_WAKEUP
  199.  
  200. windowclass/WM_WAKEUP
  201.  
  202. NAME
  203.  
  204.   WM_WAKEUP -- Wake up the window.
  205.  
  206. SYNOPSIS
  207.  
  208.   succ = DoMethod( obj, WM_WAKEUP )
  209.  
  210.   ULONG succ;
  211.  
  212. FUNCTION
  213.  
  214.   This method must be used to wake up the window again after being
  215.   put to sleep with the WM_SLEEP method. Please note that you must wake
  216.   up the window as many times as you have put it to sleep before you can
  217.   actually use it again.
  218.  
  219. INPUTS
  220.  
  221. RESULT
  222.  
  223.   succ  - TRUE upon success and FALSE upon failure.
  224.  
  225. SEE ALSO
  226.  
  227.   WM_SLEEP
  228.  
  229.